home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / bash-1.12 / dist / bashline.c < prev    next >
Encoding:
C/C++ Source or Header  |  1992-01-20  |  34.5 KB  |  1,370 lines
  1. /* bashline.c -- Bash's interface to the readline library. */
  2.  
  3. /* Copyright (C) 1987,1991 Free Software Foundation, Inc.
  4.  
  5.    This file is part of GNU Bash, the Bourne Again SHell.
  6.  
  7.    Bash is free software; you can redistribute it and/or modify it
  8.    under the terms of the GNU General Public License as published by
  9.    the Free Software Foundation; either version 1, or (at your option)
  10.    any later version.
  11.  
  12.    Bash is distributed in the hope that it will be useful, but WITHOUT
  13.    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  14.    or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
  15.    License for more details.
  16.  
  17.    You should have received a copy of the GNU General Public License
  18.    along with Bash; see the file COPYING.  If not, write to the Free
  19.    Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
  20.  
  21. #include <stdio.h>
  22. #include <readline/readline.h>
  23. #include <readline/history.h>
  24. #include "shell.h"
  25. #include "builtins.h"
  26.  
  27. /* Functions bound to keys in Readline for Bash users. */
  28. static void
  29.   shell_expand_line (), insert_last_arg (), display_shell_version (),
  30.   operate_and_get_next ();
  31.  
  32. /* Helper functions for Readline. */
  33. static void
  34.   bash_symbolic_link_hook (), filename_completion_ignore (), bash_push_line ();
  35.  
  36. static char
  37.   **attempt_shell_completion (), *variable_completion_function (),
  38.   *hostname_completion_function (), *command_word_completion_function ();
  39.  
  40. static void
  41.   snarf_hosts_from_file (), add_host_name (), sort_hostname_list ();
  42.  
  43. /* Externally defined functions used by this file. */
  44. extern char
  45.   *get_string_value (), *filename_completion_function (),
  46.   *username_completion_function ();
  47.  
  48. extern int show_shell_version ();
  49.  
  50. #define DYNAMIC_HISTORY_COMPLETION
  51. #if defined (DYNAMIC_HISTORY_COMPLETION)
  52. static void dynamic_complete_history ();
  53. #endif /* DYNAMIC_HISTORY_COMPLETION */
  54.  
  55. /* SPECIFIC_COMPLETION_FUNCTIONS specifies that we have individual
  56.    completion functions which indicate what type of completion should be
  57.    done (at or before point) that can be bound to key sequences with
  58.    the readline library. */
  59. #define SPECIFIC_COMPLETION_FUNCTIONS
  60.  
  61. #if defined (SPECIFIC_COMPLETION_FUNCTIONS)
  62. static void
  63.   bash_specific_completion (),
  64.   bash_complete_filename (), bash_possible_filename_completions (),
  65.   bash_complete_filename_internal (),
  66.   bash_complete_username (), bash_possible_username_completions (),
  67.   bash_complete_username_internal (),
  68.   bash_complete_hostname (), bash_possible_hostname_completions (),
  69.   bash_complete_hostname_internal (),
  70.   bash_complete_variable (), bash_possible_variable_completions (),
  71.   bash_complete_variable_internal (),
  72.   bash_complete_command (), bash_possible_command_completions (),
  73.   bash_complete_command_internal ();
  74. #endif /* SPECIFIC_COMPLETION_FUNCTIONS */
  75.  
  76. /* Non-zero once initalize_readline () has been called. */
  77. int bash_readline_initialized = 0;
  78.  
  79. /* Called once from parse.y if we are going to use readline. */
  80. initialize_readline ()
  81. {
  82.   if (bash_readline_initialized)
  83.     return;
  84.  
  85.   rl_terminal_name = get_string_value ("TERM");
  86.   rl_instream = stdin, rl_outstream = stderr;
  87.   rl_special_prefixes = "$@%";
  88.  
  89.   /* Allow conditional parsing of the ~/.inputrc file. */
  90.   rl_readline_name = "Bash";
  91.  
  92.   /* Bind up our special shell functions. */
  93.   rl_add_defun
  94.     ("shell-expand-line", (Function *)shell_expand_line, META(CTRL('E')));
  95.  
  96.   rl_add_defun
  97.     ("insert-last-argument", (Function *)insert_last_arg, META('.'));
  98.  
  99.   rl_bind_key (META('_'), (Function *)insert_last_arg);
  100.  
  101.   rl_add_defun
  102.     ("operate-and-get-next", (Function *)operate_and_get_next, CTRL('O'));
  103.  
  104.   rl_add_defun
  105.     ("display-shell-version", (Function *)display_shell_version, -1);
  106.  
  107.   rl_bind_key_in_map
  108.     (CTRL ('V'), (Function *)display_shell_version, emacs_ctlx_keymap);
  109.  
  110.   /* In Bash, the user can switch editing modes with "set -o [vi emacs]",
  111.      so it is not necessary to allow C-M-j for context switching.  Turn
  112.      off this occasionally confusing behaviour. */
  113.   rl_unbind_key_in_map (CTRL('J'), emacs_meta_keymap);
  114.  
  115. #ifdef SPECIFIC_COMPLETION_FUNCTIONS
  116.   rl_add_defun ("complete-filename", bash_complete_filename, META('/'));
  117.   rl_add_defun ("possible-filename-completions",
  118.         bash_possible_filename_completions, -1);
  119.   rl_bind_key_in_map ('/', bash_possible_filename_completions,
  120.               emacs_ctlx_keymap);
  121.  
  122.   rl_add_defun ("complete-username", bash_complete_username, META('~'));
  123.   rl_add_defun ("possible-username-completions",
  124.         bash_possible_username_completions, -1);
  125.   rl_bind_key_in_map ('~', bash_possible_username_completions,
  126.               emacs_ctlx_keymap);
  127.  
  128.   rl_add_defun ("complete-hostname", bash_complete_hostname, META('@'));
  129.   rl_add_defun ("possible-hostname-completions",
  130.         bash_possible_hostname_completions, -1);
  131.   rl_bind_key_in_map ('@', bash_possible_hostname_completions,
  132.               emacs_ctlx_keymap);
  133.  
  134.   rl_add_defun ("complete-variable", bash_complete_variable, META('$'));
  135.   rl_add_defun ("possible-variable-completions",
  136.         bash_possible_variable_completions, -1);
  137.   rl_bind_key_in_map ('$', bash_possible_variable_completions,
  138.               emacs_ctlx_keymap);
  139.  
  140.   rl_add_defun ("complete-command", bash_complete_command, META('!'));
  141.   rl_add_defun ("possible-command-completions",
  142.         bash_possible_command_completions, -1);
  143.   rl_bind_key_in_map ('!', bash_possible_command_completions,
  144.               emacs_ctlx_keymap);
  145.  
  146. #endif  /* SPECIFIC_COMPLETION_FUNCTIONS */
  147.  
  148. #if defined (DYNAMIC_HISTORY_COMPLETION)
  149.   rl_add_defun
  150.     ("dynamic-complete-history", dynamic_complete_history, META(TAB));
  151. #endif /* DYNAMIC_HISTORY_COMPLETION */
  152.  
  153.   /* Tell the completer that we want a crack first. */
  154.   rl_attempted_completion_function = (Function *)attempt_shell_completion;
  155.  
  156.   /* Tell the completer that we might want to follow symbolic links. */
  157.   rl_symbolic_link_hook = (Function *)bash_symbolic_link_hook;
  158.  
  159.   /* Tell the filename completer we want a chance to ignore some names. */
  160.   rl_ignore_some_completions_function =
  161.     (Function *)filename_completion_ignore;
  162.  
  163.   bash_readline_initialized = 1;
  164. }
  165.  
  166. /* On Sun systems at least, rl_attempted_completion_function can end up
  167.    getting set to NULL, and rl_completion_entry_function set to do command
  168.    word completion if Bash is interrupted while trying to complete a command
  169.    word.  This just resets all the completion functions to the right thing.
  170.    It's called from throw_to_top_level(). */
  171. bashline_reinitialize ()
  172. {
  173.   extern void tilde_initialize ();
  174.  
  175.   tilde_initialize ();
  176.   rl_attempted_completion_function = (Function *)attempt_shell_completion;
  177.   rl_symbolic_link_hook = (Function *)bash_symbolic_link_hook;
  178. }
  179.  
  180. /* Contains the line to push into readline. */
  181. static char *push_to_readline = (char *)NULL;
  182.  
  183. /* Push the contents of push_to_readline into the
  184.    readline buffer. */
  185. static void
  186. bash_push_line ()
  187. {
  188.   if (push_to_readline)
  189.     {
  190.       rl_insert_text (push_to_readline);
  191.       free (push_to_readline);
  192.       push_to_readline = (char *)NULL;
  193.     }
  194. }
  195.  
  196. /* Call this to set the initial text for the next line to read
  197.    from readline. */
  198. int
  199. bash_re_edit (line)
  200.      char *line;
  201. {
  202.   if (push_to_readline)
  203.     free (push_to_readline);
  204.  
  205.   push_to_readline = savestring (line);
  206.   rl_startup_hook = (Function *)bash_push_line;
  207.  
  208.   return (0);
  209. }
  210.  
  211. static void
  212. display_shell_version (count, c)
  213.      int count, c;
  214. {
  215.   crlf ();
  216.   show_shell_version ();
  217.   putc ('\r', rl_outstream);
  218.   fflush (rl_outstream);
  219.   rl_on_new_line ();
  220.   rl_redisplay ();
  221. }
  222.  
  223. /* **************************************************************** */
  224. /*                                    */
  225. /*                 Readline Stuff                */
  226. /*                                    */
  227. /* **************************************************************** */
  228.  
  229. /* If the user requests hostname completion, then simply build a list
  230.    of hosts, and complete from that forever more. */
  231. #if !defined (ETCHOSTS)
  232. #define ETCHOSTS "/etc/hosts"
  233. #endif
  234.  
  235. /* The kept list of hostnames. */
  236. static char **hostname_list = (char **)NULL;
  237.  
  238. /* The physical size of the above list. */
  239. static int hostname_list_size = 0;
  240.  
  241. /* The length of the above list. */
  242. static int hostname_list_length = 0;
  243.  
  244. /* Whether or not HOSTNAME_LIST has been initialized. */
  245. int hostname_list_initialized = 0;
  246.  
  247. /* Non-zero means that HOSTNAME_LIST needs to be sorted. */
  248. static int hostname_list_needs_sorting = 0;
  249.  
  250. /* Initialize the hostname completion table. */
  251. static void
  252. initialize_hostname_list ()
  253. {
  254.   char *temp = get_string_value ("hostname_completion_file");
  255.  
  256.   if (!temp)
  257.     temp = ETCHOSTS;
  258.  
  259.   snarf_hosts_from_file (temp);
  260.   sort_hostname_list ();
  261.   if (hostname_list)
  262.     hostname_list_initialized++;
  263. }
  264.  
  265. /* Add NAME to the list of hosts. */
  266. static void
  267. add_host_name (name)
  268.      char *name;
  269. {
  270.   if (hostname_list_length + 2 > hostname_list_size)
  271.     {
  272.       hostname_list = (char **)
  273.     xrealloc (hostname_list,
  274.           (1 + (hostname_list_size += 100)) * sizeof (char *));
  275.     }
  276.  
  277.   hostname_list[hostname_list_length] = savestring (name);
  278.   hostname_list[++hostname_list_length] = (char *)NULL;
  279.   hostname_list_needs_sorting++;
  280. }
  281.  
  282. /* After you have added some names, you should sort the list of names. */
  283. static void
  284. sort_hostname_list ()
  285. {
  286.   if (hostname_list_needs_sorting && hostname_list)
  287.     sort_char_array (hostname_list);
  288.   hostname_list_needs_sorting = 0;
  289. }
  290.  
  291. #define cr_whitespace(c) ((c) == '\r' || (c) == '\n' || whitespace(c))
  292.  
  293. static void
  294. snarf_hosts_from_file (filename)
  295.      char *filename;
  296. {
  297.   FILE *file = fopen (filename, "r");
  298.   char *temp, buffer[256], name[256];
  299.   register int i, start;
  300.  
  301.   if (!file)
  302.     return;
  303.  
  304.   while (temp = fgets (buffer, 255, file))
  305.     {
  306.       /* Skip to first character. */
  307.       for (i = 0; buffer[i] && cr_whitespace (buffer[i]); i++);
  308.  
  309.       /* If comment, ignore. */
  310.       if (buffer[i] == '#')
  311.     continue;
  312.  
  313.       /* If `preprocessor' directive, do the include. */
  314.       if (strncmp (&buffer[i], "$include ", 9) == 0)
  315.     {
  316.       char *includefile = &buffer[i + 9];
  317.       char *t;
  318.  
  319.       /* Find start of filename. */
  320.       while (*includefile && whitespace (*includefile))
  321.         includefile++;
  322.  
  323.       t = includefile;
  324.  
  325.       /* Find end of filename. */
  326.       while (*t && !cr_whitespace (*t))
  327.         t++;
  328.  
  329.       *t = '\0';
  330.  
  331.       snarf_hosts_from_file (includefile);
  332.       continue;
  333.     }
  334.  
  335.       /* Skip internet address. */
  336.       for (; buffer[i] && !cr_whitespace (buffer[i]); i++);
  337.  
  338.       /* Gobble up names.  Each name is separated with whitespace. */
  339.       while (buffer[i] && buffer[i] != '#')
  340.     {
  341.       for (; i && cr_whitespace (buffer[i]); i++);
  342.       if (buffer[i] ==  '#')
  343.         continue;
  344.       for (start = i; buffer[i] && !cr_whitespace (buffer[i]); i++);
  345.       if ((i - start) == 0)
  346.         continue;
  347.       strncpy (name, buffer + start, i - start);
  348.       name[i - start] = '\0';
  349.       add_host_name (name);
  350.     }
  351.     }
  352.   fclose (file);
  353. }
  354.  
  355. /* Return a NULL terminated list of hostnames which begin with TEXT.
  356.    Initialize the hostname list the first time if neccessary.
  357.    The array is malloc ()'ed, but not the individual strings. */
  358. static char **
  359. hostnames_matching (text)
  360.      char *text;
  361. {
  362.   register int i, len = strlen (text);
  363.   register int begin, end;
  364.   int last_search = -1;
  365.   char **result = (char **)NULL;
  366.  
  367.   if (!hostname_list_initialized)
  368.     {
  369.       initialize_hostname_list ();
  370.  
  371.       if (!hostname_list_initialized)
  372.     return ((char **)NULL);
  373.     }
  374.  
  375.   sort_hostname_list ();
  376.  
  377.   /* The list is sorted.  Do a binary search on it for the first character
  378.      in TEXT, and then grovel the names of interest. */
  379.   begin = 0; end = hostname_list_length;
  380.  
  381.   /* Special case.  If TEXT consists of nothing, then the whole list is
  382.      what is desired. */
  383.   if (!*text)
  384.     {
  385.       result = (char **)xmalloc ((1 + hostname_list_length) * sizeof (char *));
  386.       for (i = 0; i < hostname_list_length; i++)
  387.     result[i] = hostname_list[i];
  388.       result[i] = (char *)NULL;
  389.       return (result);
  390.     }
  391.  
  392.   /* Scan until found, or failure. */
  393.   while (end != begin)
  394.     {
  395.       int r = 0;
  396.  
  397.       i = ((end - begin) / 2) + begin;
  398.       if (i == last_search)
  399.     break;
  400.  
  401.       if (hostname_list[i] &&
  402.       (r = strncmp (hostname_list[i], text, len)) == 0)
  403.     {
  404.       while (strncmp (hostname_list[i], text, len) == 0 && i) i--;
  405.       if (strncmp (hostname_list[i], text, len) != 0) i++;
  406.  
  407.       begin = i;
  408.       while (hostname_list[i] &&
  409.          strncmp (hostname_list[i], text, len) == 0) i++;
  410.       end = i;
  411.  
  412.       result = (char **)xmalloc ((1 + (end - begin)) * sizeof (char *));
  413.       for (i = 0; i + begin < end; i++)
  414.         result[i] = hostname_list[begin + i];
  415.       result[i] = (char *)NULL;
  416.       return (result);
  417.     }
  418.  
  419.       last_search = i;
  420.  
  421.       if (r < 0)
  422.     begin = i;
  423.       else
  424.     end = i;
  425.     }
  426.   return ((char **)NULL);
  427. }
  428.  
  429. /* This is a K*rn shell style insert-last-arg function.  The
  430.    difference is that Bash puts stuff into the history file before
  431.    expansion and file name generation, so we deal with exactly what the
  432.    user typed.  Those wanting the other behavior, at least for the last
  433.    arg, can use `$_'.  This also `knows' about how rl_yank_nth_arg treats
  434.    `$'. */
  435. static void
  436. insert_last_arg (count, c)
  437.      int count, c;
  438. {
  439.   extern int rl_explicit_arg;
  440.  
  441.   if (rl_explicit_arg)
  442.     rl_yank_nth_arg (count, c);
  443.   else
  444.     rl_yank_nth_arg ('$', c);
  445. }
  446.  
  447. /* The equivalent of the K*rn shell C-o operate-and-get-next-history-line
  448.    editing command. */
  449. static int saved_history_line_to_use = 0;
  450.  
  451. static void
  452. set_saved_history ()
  453. {
  454.   HIST_ENTRY *h;
  455.  
  456.   if (saved_history_line_to_use)
  457.     {
  458.       if (history_set_pos (saved_history_line_to_use))
  459.     {
  460.       h = current_history ();
  461.       if (h)
  462.         {
  463.           rl_insert_text (h->line);
  464.           /*
  465.            * Get rid of any undo list created by the previous insert,
  466.            * so the line won't totally be erased when the edits are
  467.            * undone (they will be normally, because this is a history
  468.            * line -- cf. readline.c: line 380 or so).
  469.            */
  470.           if (rl_undo_list)
  471.         {
  472.           free_undo_list ();
  473.           rl_undo_list = (UNDO_LIST *)NULL;
  474.         }
  475.         }
  476.     }
  477.     }
  478.   saved_history_line_to_use = 0;
  479.   rl_startup_hook = (Function *)NULL;
  480. }  
  481.  
  482. static void
  483. operate_and_get_next (count, c)
  484.      int count, c;
  485. {
  486.   int where;
  487.   extern int history_stifled, history_length, max_input_history;
  488.  
  489.   /* Accept the current line. */
  490.   rl_newline ();    
  491.  
  492.   /* Find the current line, and find the next line to use. */
  493.   where = where_history ();
  494.  
  495.   if (history_stifled && (history_length >= max_input_history))
  496.     saved_history_line_to_use = where;
  497.   else
  498.     saved_history_line_to_use = where + 1;
  499.  
  500.   rl_startup_hook = (Function *)set_saved_history;
  501. }
  502.  
  503. /* **************************************************************** */
  504. /*                                    */
  505. /*            How To Do Shell Completion            */
  506. /*                                    */
  507. /* **************************************************************** */
  508.  
  509. /* Do some completion on TEXT.  The indices of TEXT in RL_LINE_BUFFER are
  510.    at START and END.  Return an array of matches, or NULL if none. */
  511. static char **
  512. attempt_shell_completion (text, start, end)
  513.      char *text;
  514.      int start, end;
  515. {
  516.   int in_command_position = 0;
  517.   char **matches = (char **)NULL;
  518.   char *command_separator_chars = ";|&{(";
  519.  
  520.   /* Determine if this could be a command word.  It is if it appears at
  521.      the start of the line (ignoring preceding whitespace), or if it
  522.      appears after a character that separates commands.  It cannot be a
  523.      command word if we aren't at the top-level prompt. */
  524.   {
  525.     register int ti = start - 1;
  526.  
  527.     while ((ti > -1) && (whitespace (rl_line_buffer[ti])))
  528.       ti--;
  529.  
  530.     if (ti < 0)
  531.       {
  532.     extern char *current_prompt_string, *ps1_prompt;
  533.  
  534.     /* Only do command completion at the start of a line when we
  535.        are not prompting at top level. */
  536.     if (current_prompt_string == ps1_prompt)
  537.       in_command_position++;
  538.       }
  539.     else
  540.       {
  541.     if (member (rl_line_buffer[ti], command_separator_chars))
  542.       in_command_position++;
  543.       }
  544.   }
  545.  
  546.   /* Variable name? */
  547.   if (*text == '$')
  548.     matches = completion_matches (text, variable_completion_function);
  549.  
  550.   /* If the word starts in `~', and there is no slash in the word, then
  551.      try completing this word as a username. */
  552.   if (!matches && *text == '~' && !index (text, '/'))
  553.     matches = completion_matches (text, username_completion_function);
  554.  
  555.   /* Another one.  Why not?  If the word starts in '@', then look through
  556.      the world of known hostnames for completion first. */
  557.   if (!matches && *text == '@')
  558.     matches = completion_matches (text, hostname_completion_function);
  559.  
  560.   /* And last, (but not least) if this word is in a command position, then
  561.      complete over possible command names, including aliases, functions,
  562.      and command names. */
  563.   if (!matches && in_command_position && *text != '/')
  564.     matches = completion_matches (text, command_word_completion_function);
  565.  
  566.   return (matches);
  567. }
  568.  
  569. /* This is the function to call when the word to complete is at the start
  570.    of a line.  It grovels $PATH, looking for commands that match.  It also
  571.    scans aliases, function names, and the shell_builtin table. */
  572. static char *
  573. command_word_completion_function (hint_text, state)
  574.      char *hint_text;
  575.      int state;
  576. {
  577.   extern SHELL_VAR **all_visible_functions ();
  578.   char *extract_colon_unit ();
  579.   static char *hint = (char *)NULL;
  580.   static char *path = (char *)NULL;
  581.   static char *val = (char *)NULL;
  582.   static char *filename_hint = (char *)NULL;
  583.   static int path_index, hint_len, istate;
  584.   static int mapping_over, local_index;
  585.   static SHELL_VAR **varlist = (SHELL_VAR **)NULL;
  586.  
  587.   /* We have to map over the possibilities for command words.  If we have
  588.      no state, then make one just for that purpose. */
  589.  
  590.   if (!state)
  591.     {
  592.       if (hint)
  593.     free (hint);
  594.  
  595.       path = get_string_value ("PATH");
  596.       path_index = 0;
  597.  
  598.       hint = savestring (hint_text);
  599.       hint_len = strlen (hint);
  600.  
  601.       mapping_over = 0;
  602.       val = (char *)NULL;
  603.  
  604.       /* Initialize the variables for each type of command word. */
  605.       local_index = 0;
  606.  
  607.       if (varlist)
  608.     free (varlist);
  609.  
  610.       varlist = all_visible_functions ();
  611.     }
  612.  
  613.   /* mapping_over says what we are currently hacking.  Note that every case
  614.      in this list must fall through when there are no more possibilities. */
  615.  
  616.   switch (mapping_over)
  617.     {
  618.     case 0:            /* Aliases come first. */
  619. #if defined (ALIAS)
  620.       while (aliases && aliases[local_index])
  621.     {
  622.       register char *alias;
  623.  
  624.       alias = aliases[local_index++]->name;
  625.  
  626.       if (strncmp (alias, hint, hint_len) == 0)
  627.         return (savestring (alias));
  628.     }
  629. #endif /* ALIAS */
  630.       local_index = 0;
  631.       mapping_over++;
  632.  
  633.     case 1:            /* Then shell reserved words. */
  634.       {
  635.     extern STRING_INT_ALIST word_token_alist[];
  636.  
  637.     while (word_token_alist[local_index].word)
  638.       {
  639.         register char *reserved_word;
  640.  
  641.         reserved_word = word_token_alist[local_index++].word;
  642.  
  643.         if (strncmp (reserved_word, hint, hint_len) == 0)
  644.           return (savestring (reserved_word));
  645.       }
  646.     local_index = 0;
  647.     mapping_over++;
  648.       }
  649.  
  650.     case 2:            /* Then function names. */
  651.       while (varlist && varlist[local_index])
  652.     {
  653.       register char *varname;
  654.  
  655.       varname = varlist[local_index++]->name;
  656.  
  657.       if (strncmp (varname, hint, hint_len) == 0)
  658.         return (savestring (varname));
  659.     }
  660.       local_index = 0;
  661.       mapping_over++;
  662.  
  663.     case 3:            /* Then shell builtins. */
  664.       for (; local_index < num_shell_builtins; local_index++)
  665.     {
  666.       if (!shell_builtins[local_index].function ||
  667.           !shell_builtins[local_index].enabled)
  668.         continue;
  669.  
  670.       if (strncmp
  671.           (shell_builtins[local_index].name, hint, hint_len) == 0)
  672.         {
  673.           int i = local_index++;
  674.  
  675.           return (savestring (shell_builtins[i].name));
  676.         }
  677.     }
  678.       local_index = 0;
  679.       mapping_over++;
  680.     }
  681.  
  682.   /* Repeatedly call filename_completion_function while we have
  683.      members of PATH left.  Question:  should we stat each file?
  684.      Answer: we call executable_file () on each file. */
  685.  outer:
  686.  
  687.   istate = (val != (char *)NULL);
  688.  
  689.   if (!istate)
  690.     {
  691.       char *current_path;
  692.  
  693.       /* Get the next directory from the path.  If there is none, then we
  694.      are all done. */
  695.       if (!path ||
  696.       !path[path_index] ||
  697.       !(current_path = extract_colon_unit (path, &path_index)))
  698.     return ((char *)NULL);
  699.  
  700.       if (!*current_path)
  701.     {
  702.       free (current_path);
  703.       current_path = savestring (".");
  704.     }
  705.  
  706.       if (*current_path == '~')
  707.     {
  708.       extern char *tilde_expand ();
  709.       char *t;
  710.  
  711.       t = tilde_expand (current_path);
  712.       free (current_path);
  713.       current_path = t;
  714.     }
  715.  
  716.       if (filename_hint)
  717.     free (filename_hint);
  718.  
  719.       filename_hint =
  720.     (char *)xmalloc (2 + strlen (current_path)
  721.              + strlen (hint));
  722.       sprintf (filename_hint, "%s/%s", current_path, hint);
  723.  
  724.       free (current_path);
  725.     }
  726.  
  727.  inner:
  728.   val = filename_completion_function (filename_hint, istate);
  729.   istate = 1;
  730.  
  731.   if (!val)
  732.     {
  733.       goto outer;
  734.     }
  735.   else
  736.     {
  737.       char *rindex (), *temp = rindex (val, '/');
  738.       temp++;
  739.       if ((strncmp (hint, temp, hint_len) == 0) && executable_file (val))
  740.     {
  741.       temp = (savestring (temp));
  742.       free (val);
  743.       val = "";    /* So it won't be NULL. */
  744.       return (temp);
  745.     }
  746.       else
  747.     {
  748.       free (val);
  749.       goto inner;
  750.     }
  751.     }
  752. }
  753.  
  754. /* Okay, now we write the entry_function for variable completion. */
  755. static char *
  756. variable_completion_function (text, state)
  757.      int state;
  758.      char *text;
  759. {
  760.   register SHELL_VAR *var = (SHELL_VAR *)NULL;
  761.   static SHELL_VAR **varlist = (SHELL_VAR **)NULL;
  762.   static int varlist_index;
  763.   static char *varname = (char *)NULL;
  764.   static int namelen;
  765.   static int first_char, first_char_loc;
  766.  
  767.   extern SHELL_VAR **all_visible_variables ();
  768.  
  769.   if (!state)
  770.     {
  771.       if (varname)
  772.     free (varname);
  773.  
  774.       first_char_loc = 0;
  775.       first_char = text[0];
  776.  
  777.       if (first_char == '$')
  778.     first_char_loc++;
  779.  
  780.       varname = savestring (&text[first_char_loc]);
  781.  
  782.       namelen = strlen (varname);
  783.       if (varlist)
  784.     free (varlist);
  785.       varlist = all_visible_variables ();
  786.       varlist_index = 0;
  787.     }
  788.  
  789.   while (varlist && varlist[varlist_index])
  790.     {
  791.       var = varlist[varlist_index];
  792.  
  793.       /* Compare.  You can't do better than Zayre.  No text is also
  794.      a match.  */
  795.       if (!*varname || (strncmp (varname, var->name, namelen) == 0))
  796.     break;
  797.       varlist_index++;
  798.     }
  799.  
  800.   if (!varlist || !varlist[varlist_index])
  801.     {
  802.       return ((char *)NULL);
  803.     }
  804.   else
  805.     {
  806.       char *value = (char *)xmalloc (2 + strlen (var->name));
  807.  
  808.       if (first_char_loc)
  809.     *value = first_char;
  810.  
  811.       strcpy (&value[first_char_loc], var->name);
  812.  
  813.       varlist_index++;
  814.       return (value);
  815.     }
  816. }
  817.  
  818. /* How about a completion function for hostnames? */
  819. static char *
  820. hostname_completion_function (text, state)
  821.      int state;
  822.      char *text;
  823. {
  824.   static char **list = (char **)NULL;
  825.   static int list_index = 0;
  826.   static int first_char, first_char_loc;
  827.  
  828.   /* If we don't have any state, make some. */
  829.   if (!state)
  830.     {
  831.       if (list)
  832.     free (list);
  833.  
  834.       list = (char **)NULL;
  835.  
  836.       first_char_loc = 0;
  837.       first_char = *text;
  838.  
  839.       if (first_char == '@')
  840.     first_char_loc++;
  841.  
  842.       list = hostnames_matching (&text[first_char_loc]);
  843.       list_index = 0;
  844.     }
  845.  
  846.   if (list && list[list_index])
  847.     {
  848.       char *t = (char *)xmalloc (2 + strlen (list[list_index]));
  849.  
  850.       *t = first_char;
  851.       strcpy (t + first_char_loc, list[list_index]);
  852.       list_index++;
  853.       return (t);
  854.     }
  855.   else
  856.     return ((char *)NULL);
  857. }
  858.  
  859. /* History and alias expand the line.  But maybe do more?  This
  860.    is a test to see what users like.  Do expand_string on the string. */
  861. static void
  862. shell_expand_line (ignore)
  863.      int ignore;
  864. {
  865.   char *pre_process_line (), *new_line;
  866.  
  867.   new_line = pre_process_line (rl_line_buffer, 0, 0);
  868.  
  869. #if defined (ALIAS)
  870.   if (new_line)
  871.     {
  872.       char *alias_expand (), *alias_line;
  873.  
  874.       alias_line = alias_expand (new_line);
  875.       free (new_line);
  876.       new_line = alias_line;
  877.     }
  878. #endif /* ALIAS */
  879.  
  880.   if (new_line)
  881.     {
  882.       int old_point = rl_point;
  883.       int at_end = rl_point == rl_end;
  884.  
  885.       /* If the line was history and alias expanded, then make that
  886.      be one thing to undo. */
  887.  
  888.       if (strcmp (new_line, rl_line_buffer) != 0)
  889.     {
  890.       rl_point = rl_end;
  891.  
  892.       rl_add_undo (UNDO_BEGIN, 0, 0, 0);
  893.       rl_kill_text (0, rl_point);
  894.       rl_point = rl_end = 0;
  895.       rl_insert_text (new_line);
  896.       rl_add_undo (UNDO_END, 0, 0, 0);
  897.     }
  898.  
  899.       free (new_line);
  900.  
  901.       /* If there is variable expansion to perform, do that as a separate
  902.      operation to be undone. */
  903.       {
  904.     extern char *string_list ();
  905.     extern WORD_LIST *expand_string ();
  906.     WORD_LIST *expanded_string;
  907.     char *string_list ();
  908.  
  909.     expanded_string = expand_string (rl_line_buffer, 0);
  910.     if (!expanded_string)
  911.       new_line = savestring ("");
  912.     else
  913.       {
  914.         new_line = string_list (expanded_string);
  915.         dispose_words (expanded_string);
  916.       }
  917.  
  918.       if (strcmp (new_line, rl_line_buffer) != 0)
  919.     {
  920.       rl_add_undo (UNDO_BEGIN, 0, 0 ,0);
  921.       rl_kill_text (0, rl_end);
  922.       rl_point = rl_end = 0;
  923.       rl_insert_text (new_line);
  924.       rl_add_undo (UNDO_END, 0, 0, 0);
  925.     }
  926.  
  927.       free (new_line);
  928.  
  929.       /* Place rl_point where we think it should go. */
  930.       if (at_end)
  931.     rl_point = rl_end;
  932.       else if (old_point < rl_end)
  933.     {
  934.       rl_point = old_point;
  935.       if (!whitespace (rl_line_buffer[rl_point]))
  936.         rl_forward_word (1);
  937.     }
  938.       }
  939.     }
  940.   else
  941.     {
  942.       /* There was an error in expansion.  Let the preprocessor print
  943.      the error here.  Note that we know that pre_process_line ()
  944.      will return NULL, since it just did. */
  945.       fprintf (rl_outstream, "\n\r");
  946.       pre_process_line (rl_line_buffer, 1, 0);
  947.       rl_forced_update_display ();
  948.     }
  949. }
  950.  
  951. /* Filename completion ignore.  Emulates the "fignore" facility of
  952.    tcsh.  If FIGNORE is set, then don't match files with the
  953.    given suffixes.  If only one of the possibilities has an acceptable
  954.    suffix, delete the others, else just return and let the completer
  955.    signal an error.  It is called by the completer when real
  956.    completions are done on filenames by the completer's internal
  957.    function, not for completion lists (M-?) and not on "other"
  958.    completion types, such as hostnames or commands.
  959.  
  960.    It is passed a NULL-terminated array of (char *)'s that must be
  961.    free()'d if they are deleted.  The first element (names[0]) is the
  962.    least-common-denominator string of the matching patterns (i.e.
  963.    u<TAB> produces names[0] = "und", names[1] = "under.c", names[2] =
  964.    "undun.c", name[3] = NULL).  */
  965.  
  966. struct ign {
  967.   char *val;
  968.   int len;
  969. };
  970.  
  971. static struct ign *ignores;    /* Store the ignore strings here */
  972. static int num_ignores;        /* How many are there? */
  973. static char *last_fignore;    /* Last value of fignore - cached for speed */
  974. extern char *extract_colon_unit (), *get_string_value ();
  975.  
  976. static void
  977. setup_ignore_patterns ()
  978. {
  979.   int numitems, maxitems, ptr;
  980.   char *colon_bit;
  981.   struct ign *p;
  982.   
  983.   char *this_fignore = get_string_value ("FIGNORE");
  984.  
  985.   /* If nothing has changed then just exit now. */
  986.   if (this_fignore &&
  987.       last_fignore && 
  988.       strcmp (this_fignore, last_fignore) == 0 ||
  989.       (!this_fignore && !last_fignore))
  990.     {
  991.       return;
  992.     }
  993.  
  994.   /* Oops.  FIGNORE has changed.  Re-parse it. */
  995.   num_ignores = 0;
  996.  
  997.   if (ignores)
  998.     {
  999.       for (p = ignores; p->val; p++) free(p->val);
  1000.       free (ignores);
  1001.       ignores = (struct ign*)NULL;
  1002.     }
  1003.  
  1004.   if (last_fignore)
  1005.     free (last_fignore);
  1006.  
  1007.   last_fignore = savestring (this_fignore);
  1008.   
  1009.   if (!this_fignore || !*this_fignore)
  1010.     return;
  1011.  
  1012.   numitems = maxitems = ptr = 0;
  1013.  
  1014.   while (colon_bit = extract_colon_unit (this_fignore, &ptr))
  1015.     {
  1016.       if (numitems + 1 > maxitems)
  1017.     ignores = (struct ign *)
  1018.       xrealloc (ignores, (maxitems += 10) * sizeof (struct ign));
  1019.  
  1020.       ignores[numitems].val = colon_bit;
  1021.       ignores[numitems].len = strlen (colon_bit);
  1022.       numitems++;
  1023.     }
  1024.   ignores[numitems].val = NULL;
  1025.   num_ignores = numitems;
  1026. }
  1027.  
  1028. static int
  1029. name_is_acceptable (name)
  1030.      char *name;
  1031. {
  1032.   struct ign *p;
  1033.   int nlen = strlen (name);
  1034.  
  1035.   for (p = ignores; p->val; p++) 
  1036.     {
  1037.       if (nlen > p->len && p->len > 0 && 
  1038.       strcmp (p->val, &name[nlen - p->len]) == 0)
  1039.     return (0);
  1040.     }
  1041.  
  1042.   return (1);
  1043. }
  1044.  
  1045. static void
  1046. filename_completion_ignore (names)
  1047.      char **names;
  1048. {
  1049.   char **p;
  1050.   int idx;
  1051.  
  1052.   setup_ignore_patterns ();
  1053.  
  1054.   if (!num_ignores)
  1055.     return;
  1056.   
  1057.   for (p = names + 1, idx = -1; *p; p++)
  1058.     {
  1059.       if (name_is_acceptable (*p))
  1060.     {
  1061.       if (idx == -1)    /* First match found. */
  1062.         idx = p - names;
  1063.       else
  1064.         return;        /* Too many matches. */
  1065.     }
  1066.     }
  1067.   
  1068.   /* If none are acceptable then let the completer handle it. */
  1069.   if (idx == -1)
  1070.     return;
  1071.  
  1072.   /* Delete all non-matching elements. */
  1073.   free (names[0]); 
  1074.   for (p = names + 1; *p; p++)
  1075.     {
  1076.       if (idx == (p - names))
  1077.     names[0] = *p;
  1078.       else 
  1079.     free (*p);
  1080.  
  1081.       *p = NULL;
  1082.     }
  1083. }
  1084.  
  1085. /* Handle symbolic link references while hacking completion. */
  1086. static void
  1087. bash_symbolic_link_hook (dirname)
  1088.      char **dirname;
  1089. {
  1090.   extern int follow_symbolic_links;
  1091.   char *make_absolute (), *temp_dirname;
  1092.  
  1093.   if (follow_symbolic_links && (strcmp (*dirname, ".") != 0))
  1094.     {
  1095.       temp_dirname = make_absolute (*dirname, get_working_directory (""));
  1096.  
  1097.       if (temp_dirname)
  1098.     {
  1099.       free (*dirname);
  1100.       *dirname = temp_dirname;
  1101.     }
  1102.     }
  1103. }
  1104.  
  1105. #if defined (DYNAMIC_HISTORY_COMPLETION)
  1106. static char **history_completion_array = (char **)NULL;
  1107. static int harry_size = 0;
  1108. static int harry_len = 0;
  1109.  
  1110. static void
  1111. build_history_completion_array ()
  1112. {
  1113.   register int i;
  1114.  
  1115.   /* First, clear out the current dynamic history completion list. */
  1116.   if (harry_size)
  1117.     {
  1118.       for (i = 0; history_completion_array[i]; i++)
  1119.     free (history_completion_array[i]);
  1120.  
  1121.       free (history_completion_array);
  1122.  
  1123.       history_completion_array = (char **)NULL;
  1124.       harry_size = 0;
  1125.       harry_len = 0;
  1126.     }
  1127.  
  1128.   /* Next, grovel each line of history, making each shell-sized token
  1129.      a separate entry in the history_completion_array. */
  1130.   {
  1131.     HIST_ENTRY **hlist;
  1132.  
  1133.     hlist = history_list ();
  1134.  
  1135.     if (hlist)
  1136.       {
  1137.     extern int qsort_string_compare ();
  1138.     register int j;
  1139.  
  1140.     for (i = 0; hlist[i]; i++)
  1141.       {
  1142.         extern char **history_tokenize ();
  1143.         char **tokens;
  1144.  
  1145.         /* Separate each token, and place into an array. */
  1146.         tokens = history_tokenize (hlist[i]->line);
  1147.  
  1148.         for (j = 0; tokens && tokens[j]; j++)
  1149.           {
  1150.         if (harry_len + 2 > harry_size)
  1151.           history_completion_array = (char **) xrealloc
  1152.             (history_completion_array,
  1153.              (harry_size += 10) * sizeof (char *));
  1154.  
  1155.         history_completion_array[harry_len++] = tokens[j];
  1156.         history_completion_array[harry_len] = (char *)NULL;
  1157.           }
  1158.         free (tokens);
  1159.       }
  1160.  
  1161.     /* Sort the complete list of tokens. */
  1162.     qsort (history_completion_array, harry_len, sizeof (char *),
  1163.            qsort_string_compare);
  1164.  
  1165.     /* Instead of removing the duplicate entries here, we let the
  1166.        code in the completer handle it. */
  1167.       }
  1168.   }
  1169. }
  1170.  
  1171. static char *
  1172. history_completion_generator (hint_text, state)
  1173.      char *hint_text;
  1174.      int state;
  1175. {
  1176.   static int local_index = 0;
  1177.   static char *text = (char *)NULL;
  1178.   static int len = 0;
  1179.  
  1180.   /* If this is the first call to the generator, then initialize the
  1181.      list of strings to complete over. */
  1182.   if (!state)
  1183.     {
  1184.       local_index = 0;
  1185.       build_history_completion_array ();
  1186.       text = hint_text;
  1187.       len = strlen (text);
  1188.     }
  1189.  
  1190.   while (history_completion_array && history_completion_array[local_index])
  1191.     {
  1192.       if (strncmp (text, history_completion_array[local_index++], len) == 0)
  1193.     return (savestring (history_completion_array[local_index - 1]));
  1194.     }
  1195.   return ((char *)NULL);
  1196. }
  1197.  
  1198. static void
  1199. dynamic_complete_history (count, key)
  1200.      int count, key;
  1201. {
  1202.   extern Function *rl_last_func;
  1203.   Function *orig_func;
  1204.   Function *orig_attempt_func;
  1205.  
  1206.   orig_func = rl_completion_entry_function;
  1207.   orig_attempt_func = rl_attempted_completion_function;
  1208.   rl_completion_entry_function = (Function *)history_completion_generator;
  1209.   rl_attempted_completion_function = (Function *)0x0;
  1210.  
  1211.   if (rl_last_func == (Function *)dynamic_complete_history)
  1212.     rl_complete_internal ('?');
  1213.   else
  1214.     rl_complete_internal (TAB);
  1215.  
  1216.   rl_completion_entry_function = orig_func;
  1217.   rl_attempted_completion_function = orig_attempt_func;
  1218. }
  1219.  
  1220. #endif /* DYNAMIC_HISTORY_COMPLETION */
  1221.  
  1222. #if defined (SPECIFIC_COMPLETION_FUNCTIONS)
  1223. static void
  1224. bash_complete_username (ignore, ignore2)
  1225.      int ignore, ignore2;
  1226. {
  1227.   bash_complete_username_internal (TAB);
  1228. }
  1229.  
  1230. static void
  1231. bash_possible_username_completions (ignore, ignore2)
  1232.      int ignore, ignore2;
  1233. {
  1234.   bash_complete_username_internal ('?');
  1235. }
  1236.  
  1237. static void
  1238. bash_complete_username_internal (what_to_do)
  1239.      int what_to_do;
  1240. {
  1241.   bash_specific_completion
  1242.     (what_to_do, (Function *)username_completion_function);
  1243. }
  1244.  
  1245. static void
  1246. bash_complete_filename (ignore, ignore2)
  1247.      int ignore, ignore2;
  1248. {
  1249.   bash_complete_filename_internal (TAB);
  1250. }
  1251.  
  1252. static void
  1253. bash_possible_filename_completions (ignore, ignore2)
  1254.      int ignore, ignore2;
  1255. {
  1256.   bash_complete_filename_internal ('?');
  1257. }
  1258.  
  1259. static void
  1260. bash_complete_filename_internal (what_to_do)
  1261.      int what_to_do;
  1262. {
  1263.   Function  *orig_func;
  1264.   Function *orig_attempt_func;
  1265.   char *orig_rl_completer_word_break_characters;
  1266.   extern char *rl_completer_word_break_characters;
  1267.  
  1268.   orig_func = rl_completion_entry_function;
  1269.   orig_attempt_func = rl_attempted_completion_function;
  1270.   orig_rl_completer_word_break_characters = rl_completer_word_break_characters;
  1271.   rl_completion_entry_function = (Function *)filename_completion_function;
  1272.   rl_attempted_completion_function = (Function *)0x0;
  1273.   rl_completer_word_break_characters = " \t\n\"\'";
  1274.  
  1275.   rl_complete_internal (what_to_do);
  1276.  
  1277.   rl_completion_entry_function = orig_func;
  1278.   rl_attempted_completion_function = orig_attempt_func;
  1279.   rl_completer_word_break_characters = orig_rl_completer_word_break_characters;
  1280. }
  1281.  
  1282. static void
  1283. bash_complete_hostname (ignore, ignore2)
  1284.      int ignore, ignore2;
  1285. {
  1286.   bash_complete_hostname_internal (TAB);
  1287. }
  1288.  
  1289. static void
  1290. bash_possible_hostname_completions (ignore, ignore2)
  1291.      int ignore, ignore2;
  1292. {
  1293.   bash_complete_hostname_internal ('?');
  1294. }
  1295.  
  1296. static void
  1297. bash_complete_variable (ignore, ignore2)
  1298.      int ignore, ignore2;
  1299. {
  1300.   bash_complete_variable_internal (TAB);
  1301. }
  1302.  
  1303. static void
  1304. bash_possible_variable_completions (ignore, ignore2)
  1305.      int ignore, ignore2;
  1306. {
  1307.   bash_complete_variable_internal ('?');
  1308. }
  1309.  
  1310.  
  1311. static void
  1312. bash_complete_command (ignore, ignore2)
  1313.      int ignore, ignore2;
  1314. {
  1315.   bash_complete_command_internal (TAB);
  1316. }
  1317.  
  1318. static void
  1319. bash_possible_command_completions (ignore, ignore2)
  1320.      int ignore, ignore2;
  1321. {
  1322.   bash_complete_command_internal ('?');
  1323. }
  1324.  
  1325. static void
  1326. bash_complete_hostname_internal (what_to_do)
  1327.      int what_to_do;
  1328. {
  1329.   bash_specific_completion
  1330.     (what_to_do, (Function *)hostname_completion_function);
  1331. }
  1332.  
  1333. static void
  1334. bash_complete_variable_internal (what_to_do)
  1335.      int what_to_do;
  1336. {
  1337.   bash_specific_completion
  1338.     (what_to_do, (Function *)variable_completion_function);
  1339. }
  1340.  
  1341. static void
  1342. bash_complete_command_internal (what_to_do)
  1343.      int what_to_do;
  1344. {
  1345.   bash_specific_completion
  1346.     (what_to_do, (Function *)command_word_completion_function);
  1347. }
  1348.  
  1349. static void
  1350. bash_specific_completion (what_to_do, generator)
  1351.      int what_to_do;
  1352.      Function *generator;
  1353. {
  1354.   Function *orig_func;
  1355.   Function *orig_attempt_func;
  1356.  
  1357.   orig_func = rl_completion_entry_function;
  1358.   orig_attempt_func = rl_attempted_completion_function;
  1359.   rl_completion_entry_function = generator;
  1360.   rl_attempted_completion_function = (Function *)0x0;
  1361.  
  1362.   rl_complete_internal (what_to_do);
  1363.  
  1364.   rl_completion_entry_function = orig_func;
  1365.   rl_attempted_completion_function = orig_attempt_func;
  1366. }
  1367.  
  1368. #endif    /* SPECIFIC_COMPLETION_FUNCTIONS */
  1369.  
  1370.